/*
 * Copyright (c) 2011-2012 Alexander Dubu
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *
 * o  Redistributions of source code must retain the above copyright notice,
 *    this list of conditions and the following disclaimer.
 *
 * o  Redistributions in binary form must reproduce the above copyright notice,
 *    this list of conditions and the following disclaimer in the documentation
 *    and/or other materials provided with the distribution.
 *
 * o  Neither the name Axil nor the names of its contributors may be used to
 *    endorse or promote products derived from this software without specific
 *    prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 * POSSIBILITY OF SUCH DAMAGE.
 */
package axil.framework.validation;

import axil.api.Formatted;
import axil.api.Formatting;
import axil.api.Persona;
import axil.framework.localization.Message;

import static axil.framework.Functions.fmt;
import static axil.framework.Functions.upper;


/**
 * An individual localized validation message. This object is intended to be
 * displayed to the user.
 */
public class ValidationMessage implements Formatted {
	public enum Severity {
		info,
		warning,
		error,
		fatal;

		public boolean within(Severity limit) {
			return this.ordinal() <= limit.ordinal();
		}

		public Severity worse(Severity other) {
			return this.ordinal() > other.ordinal() ? this : other;
		}
	}

	private final Location path;
	private final Severity severity;
	private final Message message;


	public ValidationMessage(Location path, Severity severity,
	                         Message message) {
		this.path = path;
		this.severity = severity;
		this.message = message;
	}


	public Location context() {
		return path;
	}


	public String path() {
		return path.path();
	}


	public Severity severity() {
		return severity;
	}


	/**
	 * Format this object in a locale-friendly manner. The string returned is
	 * a localized representation of this object using the locale and timezone
	 * associated with this persona. The formatting given is never null and
	 * matches formatting suitable for this type.
	 */
	public String format(Persona persona, Formatting formatting) {
		return message.format(persona, formatting);
	}


	/**
	 * Return a string representation of this object. The string returned is
	 * never null. The text returned is always in English, regardless of the
	 * locale of the current user.
	 */
	public String toString() {
		StringBuilder b = new StringBuilder(upper(severity.name()));
		b.append(": ");
		b.append(fmt(this));
		b.append(" Error occurred at ");
		b.append(path());
		b.append('.');
		return b.toString();
	}
}
